# Q. What is this file?
# A. This file contains options which allow you to configure your multiworld experience while allowing
#    others to play how they want as well.
#
# Q. How do I use it?
# A. The options in this file are weighted. This means the higher number you assign to a value, the
#    more chances you have for that option to be chosen. For example, an option like this:
#
#    map_shuffle:
#      on: 5
#      off: 15
#
#    Means you have 5 chances for map shuffle to occur, and 15 chances for map shuffle to be turned
#    off.
#
# Q. I've never seen a file like this before. What characters am I allowed to use?
# A. This is a .yaml file. You are allowed to use most characters.
#    To test if your yaml is valid or not, you can use this website:
#        http://www.yamllint.com/
#    You can also verify that your Archipelago options are valid at this site:
#        https://archipelago.gg/check

# Your name in-game, limited to 16 characters.
#     {player} will be replaced with the player's slot number.
#     {PLAYER} will be replaced with the player's slot number, if that slot number is greater than 1.
#     {number} will be replaced with the counter value of the name.
#     {NUMBER} will be replaced with the counter value of the name, if the counter value is greater than 1.
name: Player{number}

# Used to describe your yaml. Useful if you have multiple files.
description: Default Commander Keen Template

game: Commander Keen
requires:
  version: 0.6.7 # Version of Archipelago required for this yaml to work as expected.

Commander Keen:
  ################
  # Game Options #
  ################
  progression_balancing:
    # A system that can move progression earlier, to try and prevent the player from getting stuck and bored early.
    # 
    # A lower setting means more getting stuck. A higher setting means less getting stuck.
    #
    # You can define additional values between the minimum and maximum values.
    # Minimum value is 0
    # Maximum value is 99
    random: 0
    random-low: 0 # random value weighted towards lower values
    random-high: 0 # random value weighted towards higher values
    random-range-0-99: 0 # random value between 0 and 99
    disabled: 0 # equivalent to 0
    normal: 50 # equivalent to 50
    extreme: 0 # equivalent to 99

  accessibility:
    # Set rules for reachability of your items/locations.
    # 
    # **Full:** ensure everything can be reached and acquired.
    # 
    # **Minimal:** ensure what is needed to reach your goal can be acquired.
    full: 50
    minimal: 0

  episode_select:
    # Which episodes should be included in the seed.
    # ck4 = Episode 4
    # ck5 = Episode 5
    # both = Episode 4 & Episode 5
    ck4: 0
    ck5: 0
    both: 50

  enable_gemsets:
    # Whether gemsets should be enabled in the seed.
    # With this option on, you will receive all level gem items for a specific level at the same time.
    # With this option off, you will receive each level gem individually.
    'false': 0
    'true': 50

  additional_starting_levels:
    # How many additional levels should be randomly unlocked at the start of the game.
    # By default, Border Village and Slug Village in Keen 4 and Ion Ventilation System and
    # Security Center in Keen 5 are always unlocked. Additionally, the gems and keycards
    # needed to complete these levels are also unlocked from the start.
    #
    # You can define additional values between the minimum and maximum values.
    # Minimum value is 3
    # Maximum value is 10
    3: 50
    random: 0
    random-low: 0 # random value weighted towards lower values
    random-high: 0 # random value weighted towards higher values
    random-range-3-10: 0 # random value between 3 and 10

  enable_conesanity:
    # Whether to enable conesanity (Keen 4 only).
    # With this option on, every reachable Ice Cream Cone in Keen 4 (the
    # 5000-point pickup) becomes its own AP location check. Lower point
    # tiers (100/200/500/1000/2000) are NOT included; the omnispeak-ap
    # engine currently only emits checks for the 5000-pt class.
    'false': 50
    'true': 0

  enable_sugarsanity:
    # Whether to enable sugarsanity (Keen 5 only).
    # With this option on, every reachable Bag O' Sugar in Keen 5 (the
    # 5000-point pickup) becomes its own AP location check. Lower point
    # tiers (100/200/500/1000/2000) are NOT included; the omnispeak-ap
    # engine currently only emits checks for the 5000-pt class.
    'false': 50
    'true': 0

  enable_flasksanity:
    # Whether to enable flasksanity (Keen 4 only).
    # With this option on, every accessible Lifewater Flask in Keen 4 becomes
    # its own AP location check. Lifewater Flasks are the extra-life pickups
    # (no points; every 100 collected grants an extra life). Flasks known to
    # be unreachable in the original maps are excluded automatically.
    'false': 50
    'true': 0

  enable_kegsanity:
    # Whether to enable kegsanity (Keen 5 only).
    # With this option on, every Vitalin Keg in Keen 5 becomes its own AP
    # location check. Vitalin Kegs are the extra-life pickups (no points;
    # every 100 collected grants an extra life).
    'false': 50
    'true': 0

  randomize_pogo:
    # Whether the pogo stick should be randomized.
    # startwith = Start the game with the ability to use the pogo stick. This is vanilla behavior.
    # early = The pogo stick will be placed early in the seed.
    # randomize = The pogo stick can appear anywhere in the seed.
    startwith: 0
    early: 50
    randomize: 0

  randomize_stunner:
    # Whether the neural stunner should be randomized.
    # startwith = Start the game with the ability to use the stunner. This is vanilla behavior.
    # early = The stunner will be placed early in the seed.
    # randomize = The stunner can appear anywhere in the seed.
    startwith: 50
    early: 0
    randomize: 0

  randomize_wetsuit:
    # Whether the wetsuit should be randomized.
    # startwith = Start the game with the ability to use the wetsuit.
    # early = The wetsuit will be placed early in the seed.
    # randomize = The wetsuit can appear anywhere in the seed.
    startwith: 0
    early: 0
    randomize: 50

  death_link:
    # When you die, everyone who enabled death link dies. Of course, the reverse is true too.
    'false': 50
    'true': 0

  ###########################
  # Item & Location Options #
  ###########################
  local_items:
    # Forces these items to be in their native world.
    []

  non_local_items:
    # Forces these items to be outside their native world.
    []

  start_inventory:
    # Start with the specified amount of these items. Example: "Bomb: 1"
    {}

  start_hints:
    # Start with these item's locations prefilled into the ``!hint`` command.
    []

  start_location_hints:
    # Start with these locations and their item prefilled into the ``!hint`` command.
    []

  exclude_locations:
    # Prevent these locations from having an important item.
    []

  priority_locations:
    # Prevent these locations from having an unimportant item.
    []

  item_links:
    # Share part of your item pool with other players.
    []

  plando_items:
    # Generic items plando.
    []
